Add Destination

Route

/v2/streaming/destinations

Description

Create a new streaming destination with the provided configuration. Destinations define where streaming data is sent.

Method

POST

Inputs

Parameter	Type	Required	Description
name	string	Yes	Human-readable name for the destination
description	string	No	Detailed description of the destination
format	string	Yes	Data format (json_lines, json)
type	string	Yes	Destination type (https)
encoding	string	No	Data encoding (gzip, encoding_unspecified)
https_config	object	Yes	HTTPS destination configuration

HTTPS Config Object

Parameter	Type	Required	Description
uri	string	Yes	Target URI for the HTTPS destination
ignore_ssl_errors	boolean	No	Whether to ignore SSL certificate errors
username	string	No	Username for basic authentication
password	string	No	Password for basic authentication
http_headers	object	No	Additional HTTP headers to send

Request Body

{
  "name": "Security SIEM",
  "description": "Primary security information and event management system",
  "format": "json_lines",
  "type": "https",
  "encoding": "gzip",
  "https_config": {
    "uri": "https://siem.company.com/api/events",
    "ignore_ssl_errors": false,
    "username": "api_user",
    "password": "secure_password",
    "http_headers": {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json"
    }
  }
}

Output

Field	Type	Description
resources	array[Destination]	Array containing the created destination
errors	array[Error]	Any errors encountered

Rate Limit

• 60 requests per minute per API key
• 5 concurrent requests per endpoint

Example Response

{
  "resources": [
    {
      "id": "dest-789",
      "name": "Security SIEM",
      "description": "Primary security information and event management system",
      "format": "json_lines",
      "type": "https",
      "encoding": "gzip",
      "https_config": {
        "uri": "https://siem.company.com/api/events",
        "ignore_ssl_errors": false,
        "http_headers": {
          "X-API-Key": "your-api-key",
          "Content-Type": "application/json"
        }
      }
    }
  ],
  "errors": []
}